dxp-ux
Subscription (TMF-637)
/product
GET (Salesforce, Matrixx and CSG)
For LCPR prepaid customers
- API returns all products/subscriptions along with status.
- We can use this API to check if the customer number(MSISDN) is active or not. In response, if payload[x].@type=subscription and payload[x].status=Active it means MSISDN is active.
URL
https://[localhost]:[port]/dxp-ux/v1/{businessId}/productURL PARAMS
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (PR, BB, JM, PA, PR etc.) identifying the business unit. | Y |
Header
Note:
- To retrieve product information from matrixx need to pass channelId, lob and targetSystem.
- To retrieve product information from salesforce need to pass channelId.
| name | value | description | required |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. | Y |
| client_secret | string | Password associated with the client_id. | Y |
| X-Correlation-ID | string | An identifier for the current call chain that can be used to tie together log entries on multiple layers (e.g. client, server, mainframe). This identifier must be designed to be unique across all applications. Mandatory for business | N |
| lob | string | The Line of Business Identifier currently available are: FIXED PREPAID POSTPAID | M |
| channelId | string | Channel to business: In this case, expected channelId will be: "APP" Note - 'channelId' is mandatory for Mobile project | M |
| targetSystem | String | This describes the end system. “Matrixx” is in scope. | M |
Query Param
Note:
- To retrieve product information from CSG need to pass relatedParty.id, billingAccount.id and status.
- To retrieve product information from matrixx need to pass publicIdentifierType and publicIdentifier.
- To retrieve product information from salesforce need to pass productCharacteristic.name and productCharacteristic.value (Either 'realizingResource.value' or 'relatedParty.id' or 'billingAccount.id' is required as a queryParam.)
| name | type | description | required |
|---|---|---|---|
| realizingResource.value | string | Mobile device number of the customer enrolled (MSISDN) Conditional Mandatory | Y* |
| relatedParty.id | string | Unique identifier of a related entity, in this case "Customer Account Number". for fixed - CSG customer ID Conditional Mandatory | Y* |
| billingAccount.id | string | Unique identifier of the billing account, in this case in this case "Billing Account Number" Conditional Mandatory | Y* |
| productCharacteristic.name | array | Name of the characteristic to search. Could be different, depending on the use case. For Peacock Mobile Project the value will be "sourceSystem" | Y |
| productCharacteristic.value | array | The value of the characteristic. For Peacock Mobile Project the value will be Digital | Y |
| publicIdentifier | string | Public identifier value of a product, like MSISDN Example:7095659489, Subscription Id Example:S-89194 Note - 'publicIdentifier' is mandatory for Mobile project | Y |
| publicIdentifierType | string | Public identifier type value. Aallowed values are MSISDN and SubscriptionId. Note - 'publicIdentifierType' is mandatory for Mobile project | Y |
| status | string | Required for Fixed customer CSG. Possible values are - All, PendingItems, CurrentItems | Y |
Response
In this section all the possible data structures received by the client at the moment of responding the method are defined.
Possible response success
This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.
[ 200 ] Salesforce PREPAID
OK - list resource request processed successfully, response body contains an entity corresponding to the requested resource.
[
{
"id": "PR_B2C_Prepaid_4GB_Mobile_Line",
"name": "Prepaid 4GB Mobile Line",
"status": "Active",
"orderDate": "2022-10-10T00:00:00Z",
"@type": "Product",
"productCharacteristic": [
{
"name": "subscriptionId",
"value": "00103740_0000569003"
},
{
"name": "deviceState",
"value": "BYOD"
},
{
"name": "deviceType",
"value": "Mobile Phone"
},
{
"name": "mobileOfferType",
"value": "Prepaid 4GB Plan"
},
{
"name": "mobilePlanType",
"value": "Prepaid"
}
],
"productRelationship": [
{
"relationshipType": "child",
"product": {
"id": "PR_B2C_Mobile_Data_Plan",
"name": "Mobile Data Plan",
"status": "Active",
"productCharacteristic": [
{
"name": "dataSpeed",
"value": "4G"
},
{
"name": "videoQuality",
"value": "HD"
},
{
"name": "subscriptionId",
"value": "00103740_0000569004"
}
]
}
},
{
"relationshipType": "child",
"product": {
"id": "PR_B2C_Mobile_Voice_Plan",
"name": "Mobile Voice Plan",
"status": "Active",
"productCharacteristic": [
{
"name": "mobileVoicePlan",
"value": "Unlimited Voice and Text"
},
{
"name": "talkTextAllow",
"value": "Unlimited"
},
{
"name": "subscriptionId",
"value": "00103740_0000569005"
}
]
}
},
{
"relationshipType": "child",
"product": {
"id": "PR_B2C_SIM_Card",
"name": "SIM Card",
"status": "Active",
"productCharacteristic": [
{
"name": "simCardType",
"value": "Physical"
},
{
"name": "subscriptionId",
"value": "0103740_0000569008"
}
],
"realizingResource": [
{
"id": "17874030969",
"name": "MSISDN",
"@type": "LogicalResource"
},
{
"id": "8901790001870000969",
"name": "ICICID",
"@type": "PhysicalResource"
},
{
"id": "313790887000969",
"name": "IMSI",
"@type": "LogicalResource"
},
{
"id": "23456787654321",
"name": "IMEI",
"@type": "PhysicalResource"
}
]
}
}
]
}
][ 200 ] Salesforce POSTPAID
OK - list resource request processed successfully, response body contains an entity corresponding to the requested resource.
[
{
"id": "PR_B2C_Unlimited_Your_Way",
"name": "Unlimited Your Way",
"status": "Active",
"orderDate": "2022-10-20T00:00:00Z",
"@type": "Product",
"productCharacteristic": [
{
"name": "subscriptionId",
"value": "00112603_0000615450"
},
{
"name": "mobilePlanType",
"value": "PostPaid"
}
],
"productRelationship": [
{
"relationshipType": "child",
"product": {
"id": "PR_B2C_ULT_Extra_MB_Line",
"name": "Unlimited Extra Mobile Line",
"status": "Active",
"productCharacteristic": [
{
"name": "subscriptionId",
"value": "00113264_0000621111"
},
{
"name": "dataSpeed",
"value": "4G LTE/5G"
},
{
"name": "videoQuality",
"value": "SD"
},
{
"name": "talkTextAllow",
"value": "Unlimited"
},
{
"name": "simCardType",
"value": "Physical"
}
]
}
},
{
"relationshipType": "child",
"product": {
"id": "PR_B2C_ULT_Elite_MB_Line",
"name": "Unlimited Elite Mobile Line",
"status": "Active",
"productCharacteristic": [
{
"name": "subscriptionId",
"value": "00112603_0000615451"
},
{
"name": "dataSpeed",
"value": "4G LTE/5G"
},
{
"name": "videoQuality",
"value": "4K Ultra High Definition"
},
{
"name": "talkTextAllow",
"value": "Unlimited"
},
{
"name": "simCardType",
"value": "Physical"
}
],
"realizingResource": [
{
"id": "64674654564356354453",
"name": "ICCID",
"@type": "PhysicalResource"
},
{
"id": "14324323434",
"name": "MSISDN",
"@type": "LogicalResource"
}
]
}
}
]
}
]Salesforce Definitions
Each of the request parameters is detailed.
| name | type | description | required |
|---|---|---|---|
| id | String | unique reference id of the product in Salesforce | N |
| name | String | product name | N |
| status | String | product status. Allowed values: New, Active, Suspended, Cancellation in Progress, Disconnect, Deleted | N |
| @type | String | fmf field | N |
| orderDate | String | asset purchase date | N |
| productCharacteristic | Object Array | Describes a given characteristic of an object or entity through a name/value pair. | N |
| productCharacteristic.name | String | Name of the characteristic | N |
| productCharacteristic.value | String | The value of the characteristic | N |
| productRelationship | array | A list of product relationships | N |
| productRelationship.relationshipType | String | Type of the product relationship | N |
| productRelationship.product | Object | Llist of child products associated with parent product | N |
| productRelationship.product.id | String | Unique reference id of the child product in Salesforce | N |
| productRelationship.product.name | String | Child product name | N |
| productRelationship.product.status | String | Child product status | N |
| productRelationship.product. productCharacteristic | array | Describes a given characteristic of an object or entity through a name/value pair. | N |
| productRelationship.product. productCharacteristic.name | String | Name of the characteristic | N |
| productRelationship.product. productCharacteristic.value | String | The value of the characteristic | N |
| productRelationship.product. realizingResource | array | A list of resource references | N |
| productRelationship.product. realizingResource.id | String | Unique identifier of a related entity. | N |
| productRelationship.product. realizingResource.@type | String | Reference type | N |
Possible response success
This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.
[ 200 ] Matrixx PREPAID
OK - listProduct request processed successfully, response body contains an entity corresponding to the requested resource.
[
{
"id": "S-51537890",
"name": "Sub-ABC",
"description": "Subscription Info for msisdn 515378900",
"status": "Active",
"@type": "Subscription",
"productCharacteristic": [
{
"name": "LastActivityTime",
"value": "2024-12-06T05:24:17.000000-04:00"
},
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:17.000000-04:00"
},
{
"name": "UserCount",
"value": "1"
},
{
"name": "statusId",
"value": "1"
},
{
"name": "LLASubType",
"value": "1"
}
],
"relatedParty": [
{
"id": "SU-51537890",
"role": "Owner",
"@type": "SubscriptionUserRef"
}
],
"product": [
{
"id": "1",
"name": "Prepaid Subscription Setup",
"status": "active",
"startDate": "2024-12-06T05:24:17.000000-04:00",
"orderDate": "2024-12-06T05:24:17.000000-04:00",
"@type": "BasePlan",
"productOffering": {
"id": "Prepaid Subscription Setup",
"@type": "CatalogProductOfferRef"
},
"productTerm": [
{
"name": "1",
"duration": {
"amount": 1,
"units": "Monthly"
},
"validFor": {
"startDateTime": "2024-12-06T05:24:17.000000-04:00",
"endDateTime": "2025-01-06T05:24:17.000000-04:00"
},
"@type": "CycleInfoRef"
}
],
"productPrice": [
{
"productOfferingPrice": {
"id": "9",
"@type": "ProductOfferingPriceRef"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:17.000000-04:00"
},
{
"name": "CycleModifyAllowed",
"value": "true"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "CatalogItemId",
"value": "39"
},
{
"name": "OfferType",
"value": "purchased_bundle"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
],
"productSpecification": {
"id": "CPC",
"name": "CPN",
"@type": "BasePlan"
}
},
{
"id": "2",
"name": "Prepaid Balance",
"status": "active",
"startDate": "2024-12-06T05:24:17.000000-04:00",
"orderDate": "2024-12-06T05:24:17.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "11",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "1"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:17.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "PrimaryBalanceResourceId",
"value": "1"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
},
{
"id": "3",
"name": "PPU Bundle: Prepaid",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "BasePlan",
"productOffering": {
"id": "LLA: PPU Services: Prepaid",
"@type": "CatalogProductOfferRef"
},
"productPrice": [
{
"productOfferingPrice": {
"id": "153",
"@type": "ProductOfferingPriceRef"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "CatalogItemId",
"value": "117"
},
{
"name": "OfferType",
"value": "purchased_bundle"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
],
"productSpecification": {
"id": "PR_B2C_Prepaid_16GB_Mobile_Line",
"name": "Prepaid 16GB Mobile Line",
"@type": "BasePlan"
}
},
{
"id": "4",
"name": "PPU Offer: Text",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "66",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "3"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
},
{
"id": "5",
"name": "PPU Offer: MMS",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "67",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "3"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
},
{
"id": "6",
"name": "PPU Offer: Data",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "68",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "3"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
},
{
"id": "7",
"name": "PPU Offer: Voice: Prepaid Roaming",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "149",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "3"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
},
{
"id": "8",
"name": "PPU Offer: Voice: Prepaid Long Distance",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "150",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "3"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
},
{
"id": "9",
"name": "PPU Offer: Voice: Prepaid Roaming: Terminated in PR/USVI",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "155",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "3"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
},
{
"id": "10",
"name": "Setup Services",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "BasePlan",
"productOffering": {
"id": "LLA: Setup Services",
"@type": "CatalogProductOfferRef"
},
"productPrice": [
{
"productOfferingPrice": {
"id": "60",
"@type": "ProductOfferingPriceRef"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "CatalogItemId",
"value": "71"
},
{
"name": "OfferType",
"value": "purchased_bundle"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
],
"productSpecification": {
"id": "PR_B2C_Prepaid_16GB_Mobile_Line",
"name": "Prepaid 16GB Mobile Line",
"@type": "BasePlan"
}
},
{
"id": "11",
"name": "Setup Offer: Voice",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "57",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "10"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
},
{
"id": "12",
"name": "LLA: Setup Text",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "58",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "10"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
},
{
"id": "13",
"name": "LLA: Setup Data",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "59",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "10"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
},
{
"id": "14",
"name": "LLA: Setup MMS",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "62",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "10"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
},
{
"id": "15",
"name": "Prepaid Plan Attr - Shared Data",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "BasePlan",
"productOffering": {
"id": "Prepaid_Template_Shared",
"@type": "CatalogProductOfferRef"
},
"productTerm": [
{
"name": "1",
"duration": {
"amount": 30,
"units": "Daily"
},
"validFor": {
"startDateTime": "2024-12-06T00:00:00.000000-04:00",
"endDateTime": "2025-01-05T00:00:00.000000-04:00"
},
"@type": "CycleInfoRef"
}
],
"productPrice": [
{
"productOfferingPrice": {
"id": "95",
"@type": "ProductOfferingPriceRef"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "CycleModifyAllowed",
"value": "true"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "CatalogItemId",
"value": "94"
},
{
"name": "OfferType",
"value": "purchased_bundle"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
],
"productSpecification": {
"id": "PR_B2C_Prepaid_16GB_Mobile_Line",
"name": "Prepaid 16GB Mobile Line",
"@type": "BasePlan"
}
},
{
"id": "16",
"name": "LLA: MMS Offer Template: Prepaid Recurring 30 Days",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "92",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "15"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
},
{
"id": "17",
"name": "Sales Tax P1",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "79",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "15"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
},
{
"id": "18",
"name": "Sales Tax P2",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "80",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "15"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
},
{
"id": "19",
"name": "911 Fee Charge: Prepaid",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "144",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "15"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
},
{
"id": "20",
"name": "911 Fee Charge offset: Prepaid",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "145",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "15"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
},
{
"id": "21",
"name": "LLA: Voice Offer Template Intra: Prepaid Recurring 30 Days",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "41",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "15"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
},
{
"id": "22",
"name": "LLA: SMS Offer Template: Prepaid Recurring 30 Days",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "42",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "15"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
},
{
"id": "23",
"name": "LLA: Shared Data Offer Template: Prepaid Recurring 30 Days",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "73",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "15"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
},
{
"id": "24",
"name": "LLA: Voice Offer Template Inter: Prepaid Recurring 30 Days",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "143",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "15"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
},
{
"id": "25",
"name": "LifelineDiscount: GL",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "217",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "15"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
}
]
}
][ 200 ] Matrixx POSTPAID
OK - listProduct request processed successfully, response body contains an entity corresponding to the requested resource.
[
{
"id": "S-8201",
"name": "Sub-ABC",
"description": "Subscription Info for MSISDN 8201",
"status": "Active",
"@type": "Subscription",
"productCharacteristic": [
{
"name": "LastActivityTime",
"value": "2022-11-08T11:30:56.000000Z"
},
{
"name": "CurrentStatusTransitionTime",
"value": "2022-11-08T11:30:56.000000Z"
},
{
"name": "UserCount",
"value": "1"
}
],
"relatedParty": [
{
"id": "376920",
"role": "Owner",
"@type": "SubscriptionUserRef"
}
],
"product": [
{
"id": "1",
"name": "Postpaid Subscription Setup",
"status": "active",
"startDate": "2022-11-08T07:30:56.000000-04:00",
"orderDate": "2022-11-08T07:30:56.000000-04:00",
"@type": "BasePlan",
"productOffering": {
"id": "Postpaid Subscription Setup",
"@type": "CatalogProductOfferRef"
},
"productTerm": [
{
"name": "1",
"duration": {
"amount": 1,
"units": "Monthly"
},
"validFor": {
"startDateTime": "2022-11-08T07:30:56.000000-04:00",
"endDateTime": "2022-12-08T07:30:56.000000-04:00"
},
"@type": "CycleInfoRef"
}
],
"productPrice": [
{
"productOfferingPrice": {
"id": "10",
"@type": "ProductOfferingPriceRef"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2022-11-08T07:30:56.000000-04:00"
},
{
"name": "CycleModifyAllowed",
"value": "false"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "CatalogItemId",
"value": "38"
},
{
"name": "OfferType",
"value": "purchased_bundle"
},
{
"name": "AvailableAmount",
"value": "infinity"
},
{
"name": "BalanceResourceId",
"value": 1
}
],
"productSpecification": {
"id": "CPC",
"name": "CPN",
"@type": "BasePlan"
}
},
{
"id": "2",
"name": "Postpaid Balance",
"status": "active",
"startDate": "2022-11-08T07:30:56.000000-04:00",
"orderDate": "2022-11-08T07:30:56.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "53",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "1"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2022-11-08T07:30:56.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": "infinity"
},
{
"name": "BalanceResourceId",
"value": 1
}
]
}
]
}
]Matrixx Definitions
Each of the request parameters is detailed.
| name | type | description | required |
|---|---|---|---|
| id | string | External ID of the subscription. | N |
| name | string | Descriptive name of subscription. | N |
| description | string | Is the description of the response. Hard coded as static in Mule API. | N |
| status | string | Status of the subscription.Example: - created - pendingActive - cancelled - active - pendingTerminate - terminated -suspended - aborted | N |
| @type | string | The actual type of an response, @type as Subscription | N |
| productCharacteristic | array | Describes a given characteristic of an object or entity through a name/value pair. Note - Please refer Customer Characteristic below for more details | N |
| productCharacteristic.name | string | Name of the characteristic | N |
| productCharacteristic.value | any | The value of the characteristic | N |
| productCharacteristic.valueType | string | Data type of the value of the characteristic | N |
| relatedParty | array | ||
| relatedParty.id | string | Subscription User unique Id at Matrixx | N |
| relatedParty.role | string | the role of subscription user | N |
| relatedParty.@type | string | Reference of subscription user | N |
| product | array | N | |
| product.id | string | Unique identifier for this offer (within subscriber/group). | N |
| product.name | string | External ID of product offer in pricing DB. | N |
| product.status | string | The offer status. | N |
| product.startDate | datetime | When the offer was activated. Not set if status is pre-active. If active at purchase time, ActivationTime and PurchaseTime have the same value. | N |
| product.orderDate | datetime | When the offer was purchased. | N |
| product.@type | string | type of product/offer | N |
| product.productOffering | object | A EntityRef is a detailed description of a bill structure. | N |
| product.productOffering.id | string | External ID of catalog item in pricing DB, if associated with a catalog item. I.e., not for purchased offers which are part of a bundle. | N |
| product.productOffering.@type | string | 'When sub-classing, this defines the sub-class entity name' | N |
| product.productTerm | array | N | |
| product.productTerm.name | string | Unique identifier for the purchased item cycle period. | N |
| product.productTerm.duration | object | N | |
| product.productTerm.duration.amount | number | Number of periods in a purchased item cycle. | N |
| product.productTerm.duration.units | string | The period type. 1=Hourly, 2=Daily, 3=Weekly, 4=Monthly, 5=Yearly, 6=Minutes" | N |
| product.productTerm.validFor | object | N | |
| product.productTerm.validFor.startDateTime | datetime | Start of current cycle period (latest period for which recurring processing has been attempted). | N |
| product.productTerm.validFor.endDateTime | datetime | End of current cycle period (latest period for which recurring processing has been attempted). | N |
| product.productTerm.@type | string | N | |
| product.productPrice | array | N | |
| product.productPrice.productOfferingPrice | object | N | |
| product.productPrice.productOfferingPrice.id | string | ID of product offer in pricing DB. | N |
| product.productPrice.productOfferingPrice.@type | string | Refarence of ProductOfferingPrice | N |
| product.productCharacteristic | array | Describes a given characteristic of an object or entity through a name/value pair.Note - Please refer Customer Characteristic below for more details | N |
| product.productCharacteristic.name | string | Name of the characteristic | N |
| product.productCharacteristic.value | any | The value of the characteristic | N |
| product.productCharacteristic.valueType | string | Data type of the value of the characteristic | N |
| product.productRelationship | array | N | |
| product.productRelationship.relationshipType | string | Name of the relationshipType as "Parent" | N |
| product.productRelationship.product | object | N | |
| product.productRelationship.product.id | string | If this purchased offer was purchased as part of a bundle, this field holds the resource ID of the bundle. Otherwise the value is zero (null). | N |
Characteristics Values:
| Name | Description | Sample |
|---|---|---|
| LastActivityTime | This value is used for determining lifecycle inactivity trigger(s). It represents the maximum of the LastActivityUpdateTime of the subscriber and the LastActivityUpdateTime for all of the associated devices unless excluding device activity for current status definition. This field is only updated by eligible activity while in a lifecycle state which features inactivity condition(s), when transitioning status, or when the LastActivityUpdateTime is explicitly modified. | { "name": "LastActivityTime", "value": "2022-03-22T13:27:06.000000Z" } |
| CurrentStatusTransitionTime | The time at which the subscription transitioned to the current status. | { "name": "CurrentStatusTransitionTime", "value": "2022-03-22T13:27:06.000000-04:00" } |
| UserCount | Number of users for this subscription. | { "name": "UserCount", "value": "1" } |
| statusId | status Id | { "name": "statusId", "value": "1" } |
| LLASubType | LLA SubType | { "name": "LLASubType", "value": "1" } |
product.Characteristics Values:
| Name | Description | Sample |
|---|---|---|
| CurrentStatusTransitionTime | The time at which the subscription transitioned to the current status. | { "name": "CurrentStatusTransitionTime", "value": "2022-03-22T09:27:06.000000-04:00" } |
| ModifyAllowed | If true, the cycle is configured to allow for modification. | { "name": "CycleModifyAllowed", "value": "false" } |
| OfferStatusDescription | Status description of the purchased offer. | { "name": "OfferStatusDescription", "value": "active" } |
| CatalogItemId | Catalog item ID in pricing DB, if associated with a catalog item. I.e., not for purchased offers which are part of a bundle. | { "name": "CatalogItemId", "value": "39" } |
| OfferType | Type of purchased offer. 1 = purchased_offer, 2 = purchased_bundle, 3 = bundle_purchased_offer Note - Mule API is doing logic, based on description making integer as string and passing to SF. | { "name": "OfferType", "value": "purchased_bundle" } |
| PrimaryBalanceResourceId | Resource ID of primary balance. | { "name": "PrimaryBalanceResourceId", "value": "1" } |
| BalanceResourceId | Resource ID of balance. | { "name": "BalanceResourceId", "value": "1" } |
[ 200 ] CSG FIXED
OK - listProduct request processed successfully, response body contains an entity corresponding to the requested resource.
[
{
"id": "FFIPT",
"description": "Iptv1",
"startDate": "2020-05-14T10:12:00.230Z",
"@type": "Product",
"billingAccount": {
"id": "8211990010047082"
},
"productCharacteristic": [
{
"name": "Provisionable",
"value": "N"
},
{
"name": "ItemType",
"value": "S"
},
{
"name": "ItemSubType",
"value": "04"
},
{
"name": "BillingStartDate",
"value": "2022-09-05T00-00-00Z"
},
{
"name": "Quantity",
"value": "00001"
},
{
"name": "LineOfBusiness",
"value": "I"
},
{
"name": "TypeClassification",
"value": "S"
}
],
"productPrice": [
{
"priceType": "R",
"price": {
"dutyFreeAmount": {
"unit": "USD",
"value": 2.00
},
"@type": "BillingCharge"
}
}
],
"realizingService": [
{
"id": "000001",
"@type": "ServiceRef"
}
],
"place": [
{
"id": "00918424400656",
"@type": "LocationRef"
}
],
"productOrderItem": [
{
"productOrderId": "1200043219331010"
}
],
"relatedParty": [
{
"id": "1901504722008",
"@type": "CustomerRef"
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "F7B3I",
"name": "F3P-Bi-30-Us",
"isBundle": true,
"@type": "Package"
}
}
]
},
{
"id": "FFONT",
"description": "Ont",
"startDate": "2020-05-14T10:12:00.230Z",
"@type": "Product",
"billingAccount": {
"id": "8211990010047082"
},
"productCharacteristic": [
{
"name": "Provisionable",
"value": "N"
},
{
"name": "ItemType",
"value": "S"
},
{
"name": "ItemSubType",
"value": "04"
},
{
"name": "BillingStartDate",
"value": "2022-09-05T00-00-00Z"
},
{
"name": "Quantity",
"value": "00001"
},
{
"name": "LineOfBusiness",
"value": "I"
},
{
"name": "TypeClassification",
"value": "S"
}
],
"productPrice": [
{
"priceType": "R",
"price": {
"dutyFreeAmount": {
"unit": "USD",
"value": 0.00
},
"@type": "BillingCharge"
}
}
],
"realizingService": [
{
"id": "000002",
"@type": "ServiceRef"
}
],
"place": [
{
"id": "00918424400656",
"@type": "LocationRef"
}
],
"productOrderItem": [
{
"productOrderId": "1200043219331010"
}
],
"relatedParty": [
{
"id": "1901504722008",
"@type": "CustomerRef"
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "F7B3I",
"name": "F3P-Bi-30-Us",
"isBundle": true,
"@type": "Package"
}
}
]
},
{
"id": "FJ43X",
"description": "40/40 Mb",
"startDate": "2020-05-14T10:12:00.230Z",
"@type": "Product",
"billingAccount": {
"id": "8211990010047082"
},
"productCharacteristic": [
{
"name": "Provisionable",
"value": "N"
},
{
"name": "ItemType",
"value": "S"
},
{
"name": "ItemSubType",
"value": "04"
},
{
"name": "BillingStartDate",
"value": "2022-09-05T00-00-00Z"
},
{
"name": "Quantity",
"value": "00001"
},
{
"name": "LineOfBusiness",
"value": "I"
},
{
"name": "TypeClassification",
"value": "S"
}
],
"productPrice": [
{
"priceType": "R",
"price": {
"dutyFreeAmount": {
"unit": "USD",
"value": 35.99
},
"@type": "BillingCharge"
}
}
],
"realizingService": [
{
"id": "000003",
"@type": "ServiceRef"
}
],
"place": [
{
"id": "00918424400656",
"@type": "LocationRef"
}
],
"productOrderItem": [
{
"productOrderId": "1200043219331010"
}
],
"relatedParty": [
{
"id": "1901504722008",
"@type": "CustomerRef"
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "F7B3I",
"name": "F3P-Bi-30-Us",
"isBundle": true,
"@type": "Package"
}
}
]
},
{
"id": "FW4US",
"description": "F Pr/Us Voip",
"startDate": "2020-05-14T10:12:00.230Z",
"@type": "Product",
"billingAccount": {
"id": "8211990010047082"
},
"productCharacteristic": [
{
"name": "ProvisioningStatus",
"value": "PA"
},
{
"name": "Provisionable",
"value": "Y"
},
{
"name": "ItemType",
"value": "S"
},
{
"name": "ItemSubType",
"value": "03"
},
{
"name": "BillingStartDate",
"value": "2022-09-05T00-00-00Z"
},
{
"name": "Quantity",
"value": "00001"
},
{
"name": "LineOfBusiness",
"value": "T"
},
{
"name": "TypeClassification",
"value": "S"
}
],
"productPrice": [
{
"priceType": "R",
"price": {
"dutyFreeAmount": {
"unit": "USD",
"value": 10.00
},
"@type": "BillingCharge"
}
}
],
"realizingResource": [
{
"id": "9395455897 ",
"@type": "Telephone"
}
],
"realizingService": [
{
"id": "000004",
"@type": "ServiceRef"
}
],
"place": [
{
"id": "00918424400656",
"@type": "LocationRef"
}
],
"productOrderItem": [
{
"productOrderId": "1200043219331010"
}
],
"relatedParty": [
{
"id": "1901504722008",
"@type": "CustomerRef"
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "F7B3I",
"name": "F3P-Bi-30-Us",
"isBundle": true,
"@type": "Package"
}
}
]
},
{
"id": "RV3BC",
"description": "Broadcast Sv",
"startDate": "2020-05-14T10:12:00.230Z",
"@type": "Product",
"billingAccount": {
"id": "8211990010047082"
},
"productCharacteristic": [
{
"name": "Provisionable",
"value": "N"
},
{
"name": "ItemType",
"value": "S"
},
{
"name": "ItemSubType",
"value": "01"
},
{
"name": "BillingStartDate",
"value": "2022-09-05T00-00-00Z"
},
{
"name": "Quantity",
"value": "00001"
},
{
"name": "LineOfBusiness",
"value": "C"
},
{
"name": "TypeClassification",
"value": "S"
}
],
"productPrice": [
{
"priceType": "R",
"price": {
"dutyFreeAmount": {
"unit": "USD",
"value": 15.00
},
"@type": "BillingCharge"
}
}
],
"realizingService": [
{
"id": "000005",
"@type": "ServiceRef"
}
],
"place": [
{
"id": "00918424400656",
"@type": "LocationRef"
}
],
"productOrderItem": [
{
"productOrderId": "1200043219331010"
}
],
"relatedParty": [
{
"id": "1901504722008",
"@type": "CustomerRef"
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "F7B3I",
"name": "F3P-Bi-30-Us",
"isBundle": true,
"@type": "Package"
}
}
]
},
{
"id": "ZY101",
"description": "Res Data A/O",
"startDate": "2020-05-14T10:12:00.230Z",
"@type": "Product",
"billingAccount": {
"id": "8211990010047082"
},
"productCharacteristic": [
{
"name": "Provisionable",
"value": "N"
},
{
"name": "ItemType",
"value": "S"
},
{
"name": "ItemSubType",
"value": "03"
},
{
"name": "BillingStartDate",
"value": "2022-09-05T00-00-00Z"
},
{
"name": "Quantity",
"value": "00001"
},
{
"name": "LineOfBusiness",
"value": "I"
},
{
"name": "TypeClassification",
"value": "S"
}
],
"productPrice": [
{
"priceType": "R",
"price": {
"dutyFreeAmount": {
"unit": "USD",
"value": 0.00
},
"@type": "BillingCharge"
}
}
],
"realizingService": [
{
"id": "000006",
"@type": "ServiceRef"
}
],
"place": [
{
"id": "00918424400656",
"@type": "LocationRef"
}
],
"productOrderItem": [
{
"productOrderId": "1200043219331010"
}
],
"relatedParty": [
{
"id": "1901504722008",
"@type": "CustomerRef"
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "F7B3I",
"name": "F3P-Bi-30-Us",
"isBundle": true,
"@type": "Package"
}
}
]
},
{
"id": "FRRUS",
"description": "Callplanprus",
"startDate": "2020-05-14T10:12:00.230Z",
"@type": "Product",
"billingAccount": {
"id": "8211990010047082"
},
"productCharacteristic": [
{
"name": "ProvisioningStatus",
"value": "PA"
},
{
"name": "Provisionable",
"value": "Y"
},
{
"name": "ItemType",
"value": "S"
},
{
"name": "ItemSubType",
"value": "04"
},
{
"name": "BillingStartDate",
"value": "2022-09-05T00-00-00Z"
},
{
"name": "Quantity",
"value": "00001"
},
{
"name": "LineOfBusiness",
"value": "T"
},
{
"name": "TypeClassification",
"value": "S"
}
],
"productPrice": [
{
"priceType": "R",
"price": {
"dutyFreeAmount": {
"unit": "USD",
"value": 0.00
},
"@type": "BillingCharge"
}
}
],
"realizingResource": [
{
"id": "9395455897 ",
"@type": "Telephone"
}
],
"realizingService": [
{
"id": "000007",
"@type": "ServiceRef"
}
],
"place": [
{
"id": "00918424400656",
"@type": "LocationRef"
}
],
"productOrderItem": [
{
"productOrderId": "1200043219331010"
}
],
"relatedParty": [
{
"id": "1901504722008",
"@type": "CustomerRef"
}
]
},
{
"id": "RZ020",
"description": "Ndvr 20Hrs",
"startDate": "2020-05-14T10:12:00.230Z",
"@type": "Product",
"billingAccount": {
"id": "8211990010047082"
},
"productCharacteristic": [
{
"name": "Provisionable",
"value": "N"
},
{
"name": "ItemType",
"value": "S"
},
{
"name": "ItemSubType",
"value": "02"
},
{
"name": "BillingStartDate",
"value": "2022-09-05T00-00-00Z"
},
{
"name": "Quantity",
"value": "00001"
},
{
"name": "LineOfBusiness",
"value": "C"
},
{
"name": "TypeClassification",
"value": "S"
}
],
"productPrice": [
{
"priceType": "R",
"price": {
"dutyFreeAmount": {
"unit": "USD",
"value": 0.00
},
"@type": "BillingCharge"
}
}
],
"realizingService": [
{
"id": "000008",
"@type": "ServiceRef"
}
],
"place": [
{
"id": "00918424400656",
"@type": "LocationRef"
}
],
"productOrderItem": [
{
"productOrderId": "1200043219331010"
}
],
"relatedParty": [
{
"id": "1901504722008",
"@type": "CustomerRef"
}
]
},
{
"id": "ZMPBI",
"description": "Paper Billin",
"startDate": "2020-05-14T10:12:00.230Z",
"@type": "Product",
"billingAccount": {
"id": "8211990010047082"
},
"productCharacteristic": [
{
"name": "Provisionable",
"value": "N"
},
{
"name": "ItemType",
"value": "S"
},
{
"name": "ItemSubType",
"value": "04"
},
{
"name": "BillingStartDate",
"value": "2022-09-05T00-00-00Z"
},
{
"name": "Quantity",
"value": "00001"
},
{
"name": "LineOfBusiness",
"value": "N"
},
{
"name": "TypeClassification",
"value": "S"
}
],
"productPrice": [
{
"priceType": "R",
"price": {
"dutyFreeAmount": {
"unit": "USD",
"value": 3.00
},
"@type": "BillingCharge"
}
}
],
"realizingService": [
{
"id": "000009",
"@type": "ServiceRef"
}
],
"place": [
{
"id": "00918424400656",
"@type": "LocationRef"
}
],
"productOrderItem": [
{
"productOrderId": "1200043219331010"
}
],
"relatedParty": [
{
"id": "1901504722008",
"@type": "CustomerRef"
}
]
}
]CSG Definitions
Each of the request parameters is detailed.
| name | type | description | required |
|---|---|---|---|
| id | string | External ID of the subscription. | N |
| name | string | Descriptive name of subscription. | N |
| description | string | Is the description of the response. Hard coded as static in Mule API. | N |
| startDate | dateTime | Is the date from which the product starts. | N |
| status | string | Status of the subscription.Example: - created - pendingActive - cancelled - active - pendingTerminate - terminated -suspended - aborted | N |
| @type | string | The actual type of an response, @type as Subscription | N |
| billingAccount | object | A BillingAccountRef. BillingAccount reference. A BillingAccount is a detailed description of a bill structure. | N |
| billingAccount.id | string | Unique identifier. | N |
| productCharacteristic | array | Describes a given characteristic of an object or entity through a name/value pair. Note - Please refer Customer Characteristic below for more details | N |
| productCharacteristic.name | string | Name of the characteristic | N |
| productCharacteristic.value | any | The value of the characteristic | N |
| productPrice | array | Description of price and discount awarded. | N |
| productPrice.priceType | string | A category that describes the price such as recurring, one time and usage. | N |
| productPrice.price | string | Provides all amounts (tax included, duty free, tax rate), used currency and percentage to apply for Price and Price Alteration. | N |
| productPrice.price.dutyFreeAmount | string | A base / value business entity used to represent money. | N |
| productPrice.price.'@type' | string | 'When sub-classing, this defines the sub-class entity name' | N |
| realizingService | array | Service reference, for when Service is used by other entities. | N |
| realizingService.id | string | Unique identifier. | N |
| realizingService.'@type' | string | When sub-classing, this defines the sub-class Extensible name. | N |
| place | array | Entity for place | N |
| place.id | string | Unique identifier. | N |
| place.'@type' | string | When sub-classing, this defines the sub-class Extensible name. | N |
| productOrderItem | array | N | |
| productOrderItem.productOrderId | string | Unique identifier for this order | N |
| relatedParty | array | ||
| relatedParty.id | string | Subscription User unique Id at Matrixx | N |
| relatedParty.@type | string | Reference of subscription user | N |
| productRelationship | array | N | |
| productRelationship.relationshipType | string | Name of the relationshipType as "Parent" | N |
| productRelationship.product | object | N | |
| productRelationship.product.id | string | If this purchased offer was purchased as part of a bundle, this field holds the resource ID of the bundle. Otherwise the value is zero (null). | N |
| productRelationship.product.name | string | Name of the product. It could be the same as the name of the product offering. | N |
| productRelationship.product.isBundle | boolean | If true, the product is a ProductBundle which is an instantiation of a BundledProductOffering. If false, the product is a ProductComponent which is an instantiation of a SimpleProductOffering. | N |
| productRelationship.product.'@type' | string | If this purchased offer was purchased as part of a bundle, this field holds the resource ID of the bundle. Otherwise the value is zero (null). | N |
Possible Error Scenarios: :
IF WE ARE PASSING INVALID (publicIdentifier) IN QUERYPARAMS
{
"errors": [
{
"code": 400,
"message": "MATRIXX:PRODUCTINVENTORY_REPORT",
"description": "11 | Subscriber not found (AccessNumber=8919414206)"
}
]
}IF WE ARE PASSING INVALID (publicIdentifierType) IN QUERYPARAMS
{
"errors": [
{
"code": 400,
"message": "VALIDATION:MISMATCH",
"description": "PublicIdentifierType is not valid. Expected values are : SubscriptionId | MSISDN"
}
]
}IF WE ARE PASSING INVALID CHANNELID
{
"errors": [
{
"code": 501,
"message": "LLA:NOT_IMPLEMENTED",
"description": "There is no Implementation available for this BU"
}
]
}IF WE ARE PASSING INVALID SECURITY HEADERS
{
"error": "Invalid Client"
}